This repository has been archived by the owner on Nov 8, 2022. It is now read-only.
(PoC) Swagger spec in comments #1497
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This enables to use swagger tooling around e.g. go on pet store and explore the url https://raw.githubusercontent.com/kindermoumoute/snap/swagger/mgmt/rest/v2/swagger.json |
kindermoumoute
force-pushed
the
swagger
branch
from
00ca90d to
00c699c
Compare
- Add Swagger comments - Add test to verify swagger comments respect standard
kindermoumoute
force-pushed
the
swagger
branch
from
00c699c to
8254133
Compare
|
@kindermoumoute, Well done POC. Great work! We'll incorporate your ideas into our future work! thanks. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use Swagger to generate API documentation and client
Date Open: 01/26/2017
Date To Close: 02/03/2017
Required Participants: @candysmurf @jcooklin @IRCody
Summary: Swagger is a tool that allows to create client, server and documentation for APIs from a single specification file. This specification file can also be generated from comments in the code.
Proposal: Generate Swagger specification from the code in order to generate clients and documentation for Snap API.
Write Swagger comments in the code to generate a proper specification file
Generate API documentation from specification file
Create Go client from specification file
Create API server from specification file.
PoC
Summary of changes:
swagger.jsonTesting done:
swagger.jsonrespects standardswagger.json(should be the same)